package com.chengxiaoxiao.ai_demo.api;

import com.chengxiaoxiao.ai_demo.entity.KnowledgeFile;
import com.chengxiaoxiao.ai_demo.vo.PageResult;
import com.chengxiaoxiao.ai_demo.vo.Result;
import com.chengxiaoxiao.ai_demo.vo.query.KnowledgeFileQuery;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;

import java.util.List;


/**
 * 知识库文件 接口Swagger Api
 *
 * @Description:
 * @Author: Cheng Xiaoxiao
 * @Date: 2025-03-14 16:50:21
 */
@Tag(name = "知识库文件模块")
public interface KnowledgeFileControllerApi {


    /**
     * 按照条件查询知识库文件信息
     *
     * @param knowledgeFileQuery 查询条件
     * @return 结果信息
     */
    @Operation(summary = "按照条件查询知识库文件信息")
    Result<List<KnowledgeFile>> list(@Parameter(description = "查询条件") KnowledgeFileQuery knowledgeFileQuery);

    /**
     * 分页及条件查询知识库文件信息
     *
     * @param page               页码
     * @param size               分页大小
     * @param knowledgeFileQuery 查询条件
     * @return 分页结果信息
     */
    @Operation(summary = "分页及条件查询知识库文件信息")
    Result<PageResult<KnowledgeFile>> search(@Parameter(description = "页码大小") Long size,
                                             @Parameter(description = "当前页") Long page,
                                             @Parameter(description = "查询条件") KnowledgeFileQuery knowledgeFileQuery);

    /**
     * 根据ID获取知识库文件详情
     *
     * @param id 知识库文件ID
     * @return 知识库文件详细信息
     */
    @Operation(summary = "获取单个知识库文件详情")
    Result<KnowledgeFile> detail(@Parameter(description = "知识库文件ID") String id);

    /**
     * 增加知识库文件信息
     *
     * @param knowledgeFile 知识库文件增加实体
     * @return 增加后的知识库文件信息
     */
    @Operation(summary = "增加知识库文件信息")
    Result<KnowledgeFile> add(KnowledgeFile knowledgeFile);

    /**
     * 修改知识库文件信息
     *
     * @param id            知识库文件ID
     * @param knowledgeFile 知识库文件修改实体
     * @return 修改后的知识库文件信息
     */
    @Operation(summary = "修改知识库文件信息")
    Result<KnowledgeFile> updateById(@Parameter(description = "知识库文件ID") String id, KnowledgeFile knowledgeFile);

    /**
     * 删除知识库文件信息
     *
     * @param id 知识库文件ID
     * @return 删除结果信息
     */
    @Operation(summary = "删除单个知识库文件信息")
    Result<Boolean> deleteById(@Parameter(description = "知识库文件ID") String id);

    /**
     * 删除知识库文件信息
     *
     * @param idList 知识库文件ID数组
     * @return 删除结果信息
     */
    @Operation(summary = "批量删除知识库文件信息")
    Result<Boolean> batchRemove(@Parameter(description = "ID集合") List<String> idList);
}
